<!DOCTYPE html><html xmlns:date="http://exslt.org/dates-and-times" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width; initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<meta charset="utf-8">
<title>Plurious Framework » \framework\engine\Actions</title>
<meta name="author" content="Mike van Riel">
<meta name="description" content="">
<link href="../css/template.css" rel="stylesheet" media="all">
<script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script><script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script><script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script><script src="../js/bootstrap.js" type="text/javascript"></script><script src="../js/template.js" type="text/javascript"></script><script src="../js/prettify/prettify.min.js" type="text/javascript"></script><link rel="shortcut icon" href="../img/favicon.ico">
<link rel="apple-touch-icon" href="../img/apple-touch-icon.png">
<link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png">
<link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png">
</head>
<body>
<div class="navbar navbar-fixed-top">
<div class="navbar-inner"><div class="container">
<a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse"><span class="icon-bar"></span><span class="icon-bar"></span><span class="icon-bar"></span></a><a class="brand" href="../index.html">Plurious Framework</a><div class="nav-collapse"><ul class="nav">
<li class="dropdown">
<a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                    API Documentation <b class="caret"></b></a><ul class="dropdown-menu">
<li><a>Namespaces</a></li>
<li><a href="../namespaces/framework.html"><i class="icon-th"></i> framework</a></li>
<li><a href="../namespaces/global.html"><i class="icon-th"></i> global</a></li>
<li><a href="../namespaces/plurious.html"><i class="icon-th"></i> plurious</a></li>
</ul>
</li>
<li class="dropdown" id="charts-menu">
<a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                    Charts <b class="caret"></b></a><ul class="dropdown-menu"><li><a href="../graph_class.html"><i class="icon-list-alt"></i> Class hierarchy diagram</a></li></ul>
</li>
<li class="dropdown" id="reports-menu">
<a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                    Reports <b class="caret"></b></a><ul class="dropdown-menu">
<li><a href="../errors.html"><i class="icon-remove-sign"></i> Errors 
                <span class="label label-info">439</span></a></li>
<li><a href="../markers.html"><i class="icon-map-marker"></i> Markers 
                <ul><li>todo 
                <span class="label label-info">82</span>
</li></ul></a></li>
<li><a href="../deprecated.html"><i class="icon-stop"></i> Deprecated elements 
                <span class="label label-info">0</span></a></li>
</ul>
</li>
</ul></div>
</div></div>
<div class="go_to_top"><a href="#___" style="color: inherit">Back to top  <i class="icon-upload icon-white"></i></a></div>
</div>
<div id="___" class="container">
<noscript><div class="alert alert-warning">
                            Javascript is disabled; several features are only available
                            if Javascript is enabled.
                        </div></noscript>
<div class="row">
<div class="span4">
<span class="btn-group visibility" data-toggle="buttons-checkbox"><button class="btn public active" title="Show public elements">Public</button><button class="btn protected" title="Show protected elements">Protected</button><button class="btn private" title="Show private elements">Private</button><button class="btn inherited active" title="Show inherited elements">Inherited</button></span><div class="btn-group view pull-right" data-toggle="buttons-radio">
<button class="btn details" title="Show descriptions and method names"><i class="icon-list"></i></button><button class="btn simple" title="Show only method names"><i class="icon-align-justify"></i></button>
</div>
<ul class="side-nav nav nav-list">
<li class="nav-header">
<i class="icon-custom icon-method"></i> Methods</li>
<li class="method public "><a href="#__construct" title="__construct :: Grabs the registry, sets the output into the registry and sets up routing."><span class="description">Grabs the registry, sets the output into the registry and sets up routing.</span><pre>__construct()</pre></a></li>
<li class="method public "><a href="#addAction" title="addAction :: Creates the action array with the file paths provided by the router."><span class="description">Creates the action array with the file paths provided by the router.</span><pre>addAction()</pre></a></li>
<li class="method public "><a href="#addModule" title="addModule :: Adds a module as a child action of the main action"><span class="description">Adds a module as a child action of the main action</span><pre>addModule()</pre></a></li>
<li class="method public inherited"><a href="#buildRoutes" title="buildRoutes :: Build and test routes to controller, model and template"><span class="description">Build and test routes to controller, model and template</span><pre>buildRoutes()</pre></a></li>
<li class="method public "><a href="#clearAll" title="clearAll :: Clear all action arrays"><span class="description">Clear all action arrays</span><pre>clearAll()</pre></a></li>
<li class="method public "><a href="#run" title="run :: Creates the main action (or clears current main action if there is one),
then executes the new main action."><span class="description">Creates the main action (or clears current main action if there is one),
then executes the new main action.</span><pre>run()</pre></a></li>
<li class="nav-header protected">» Protected</li>
<li class="method protected inherited"><a href="#breadcrumbs" title="breadcrumbs :: Creates and manages a list of breadcrumbs"><span class="description">Creates and manages a list of breadcrumbs</span><pre>breadcrumbs()</pre></a></li>
<li class="nav-header private">» Private</li>
<li class="method private inherited"><a href="#buildDirectories" title="buildDirectories :: Decomposes provded route and sets file paths for controller, model and template
while a fully qualified namespaced class name, the method to call inside that
class and any parameters to pass to the method."><span class="description">Decomposes provded route and sets file paths for controller, model and template
while a fully qualified namespaced class name, the method to call inside that
class and any parameters to pass to the method.</span><pre>buildDirectories()</pre></a></li>
<li class="method private inherited"><a href="#clearRoutes" title="clearRoutes :: Clears out the usefull data from the class."><span class="description">Clears out the usefull data from the class.</span><pre>clearRoutes()</pre></a></li>
<li class="method private "><a href="#execute" title="execute :: Executes the action by instantiating requested controller and method."><span class="description">Executes the action by instantiating requested controller and method.</span><pre>execute()</pre></a></li>
<li class="nav-header">
<i class="icon-custom icon-property"></i> Properties</li>
<li class="nav-header protected">» Protected</li>
<li class="property protected inherited"><a href="#%24class" title="$class :: holds fully qualified namespaced class name"><span class="description">holds fully qualified namespaced class name</span><pre>$class</pre></a></li>
<li class="property protected "><a href="#%24context" title="$context :: holds the app name as context"><span class="description">holds the app name as context</span><pre>$context</pre></a></li>
<li class="property protected inherited"><a href="#%24controller" title="$controller :: holds fully qualified file path to the controller name being processed"><span class="description">holds fully qualified file path to the controller name being processed</span><pre>$controller</pre></a></li>
<li class="property protected "><a href="#%24front" title="$front :: "><span class="description">$front</span><pre>$front</pre></a></li>
<li class="property protected "><a href="#%24layout" title="$layout :: "><span class="description">$layout</span><pre>$layout</pre></a></li>
<li class="property protected inherited"><a href="#%24layout_name" title="$layout_name :: holds the name of the view layout - this is the directory name for the view templates"><span class="description">holds the name of the view layout - this is the directory name for the view templates</span><pre>$layout_name</pre></a></li>
<li class="property protected inherited"><a href="#%24method" title="$method :: hold requested method if a method was requested"><span class="description">hold requested method if a method was requested</span><pre>$method</pre></a></li>
<li class="property protected inherited"><a href="#%24methodArgs" title="$methodArgs :: holds an array of method arguments pass along with route to method"><span class="description">holds an array of method arguments pass along with route to method</span><pre>$methodArgs</pre></a></li>
<li class="property protected inherited"><a href="#%24model" title="$model :: holds the fully qualified file path to the model"><span class="description">holds the fully qualified file path to the model</span><pre>$model</pre></a></li>
<li class="property protected inherited"><a href="#%24template" title="$template :: holds  fully qualified file path to the associated template"><span class="description">holds  fully qualified file path to the associated template</span><pre>$template</pre></a></li>
</ul>
</div>
<div class="span8">
<a name="%5Cframework%5Cengine%5CActions" id="\framework\engine\Actions"></a><ul class="breadcrumb">
<li>
<a href="../index.html"><i class="icon-custom icon-class"></i></a><span class="divider">\</span>
</li>
<li><a href="../namespaces/framework.html">framework</a></li>
<span class="divider">\</span><li><a href="../namespaces/framework.engine.html">engine</a></li>
<li class="active">
<span class="divider">\</span><a href="../classes/framework.engine.Actions.html">Actions</a>
</li>
</ul>
<div href="../classes/framework.engine.Actions.html" class="element class">
<p class="short_description">Collects and dispatches multiple controller actions in a recursive fashion.</p>
<div class="details">
<p class="long_description"><p>This class is very tightly coupled to the Actions Class</p></p>
<table class="table table-bordered">
<tr>
<th>author</th>
<td><a href="mailto:randy@plurious.com">Randy Casburn</a></td>
</tr>
<tr>
<th>copyright</th>
<td>Copyright Plurious Software, all rights reserved</td>
</tr>
<tr>
<th>license</th>
<td><a href="http://opensource.org/licenses/MIT">MIT</a></td>
</tr>
<tr>
<th>license</th>
<td><a href="http://www.opensource.org/licenses/mit-license.html">http://www.opensource.org/licenses/mit-license.html</a></td>
</tr>
<tr>
<th>link</th>
<td><a href="http://plurious.com/framework/documentation/classes/Front.html">http://plurious.com/framework/documentation/classes/Front.html</a></td>
</tr>
<tr>
<th>version</th>
<td>2.1</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\Front</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\engine\Document</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Footer::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Footer::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Footer::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Footer::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Header::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Header::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Header::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\common\Header::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Auth_Failure::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Auth_Failure::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Auth_Failure::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Auth_Failure::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Not_found::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Not_found::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Not_found::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\error\Not_found::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\Home::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\Home::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\Home::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\admin\controller\Home::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Footer::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Footer::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Footer::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Footer::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Header::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Header::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Header::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\common\Header::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Auth_Failure::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Auth_Failure::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Auth_Failure::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Auth_Failure::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Not_found::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Not_found::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Not_found::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\error\Not_found::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\Home::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\Home::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\Home::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\apps\web\controller\Home::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Controller::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Controller::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Controller::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Controller::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Home::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Home::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Home::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\framework\engine\Home::addModules()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\modules\login\Login::forward()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\modules\login\Login::addChild()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\modules\login\Login::addChildren()</td>
</tr>
<tr>
<th>used_by</th>
<td>\plurious\modules\login\Login::addModules()</td>
</tr>
</table>
<h3>
<i class="icon-custom icon-method"></i> Methods</h3>
<a name="__construct" id="__construct"></a><div class="element clickable method public __construct" data-toggle="collapse" data-target=".__construct .collapse">
<h2>Grabs the registry, sets the output into the registry and sets up routing.</h2>
<pre>__construct() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="addAction" id="addAction"></a><div class="element clickable method public addAction" data-toggle="collapse" data-target=".addAction .collapse">
<h2>Creates the action array with the file paths provided by the router.</h2>
<pre>addAction(mixed $route, mixed $type) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Throws a 404 if a route cannot be resolved.</p>

<p>Sets up three sets of actions and one main action:
preActions - these run prior to the main action
childActions - Sub-page actions (controllers) that suplement the main action content
postActions - these run after the main action
mainAction - There is only one and is the main page controller from the URI</p></p>
<table class="table table-bordered"><tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$route</h4>
<code>mixed</code><p>Route in the form /context/controller/method/arg/arg/...</p>
</div>
<div class="subelement argument">
<h4>$type</h4>
<code>mixed</code><p>pre, main, post</p></div>
</div></div>
</div>
<a name="addModule" id="addModule"></a><div class="element clickable method public addModule" data-toggle="collapse" data-target=".addModule .collapse">
<h2>Adds a module as a child action of the main action</h2>
<pre>addModule(\framework\engine\type $route) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>This method uses strict path definitions to find and build an action
based upon the provided route.</p>

<p>Modules can include other modules and other children controllers just
like any other controller can.</p>

<p>NOTE: The route provided for a module is different than a route for other
actions.  The route for a module does not include a context and has the
module name followed by a method and arguments.</p></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr>
<tr>
<th>uses</th>
<td>\framework\engine\Document</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$route</h4>
<code>\framework\engine\type</code><p>Route in the form /module_name/method/arg/arg/...</p>
</div>
</div></div>
</div>
<a name="buildRoutes" id="buildRoutes"></a><div class="element clickable method public buildRoutes" data-toggle="collapse" data-target=".buildRoutes .collapse">
<h2>Build and test routes to controller, model and template</h2>
<pre>buildRoutes(string $route) : mixed</pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::buildRoutes()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$route</h4>
<code>string</code><p>a route in the form [context/]controller[/method/arg/arg/...]</p>
</div>
<h3>Returns</h3>
<div class="subelement response">
<code>mixed</code>false if controller not found array of method parameters otherwise</div>
</div></div>
</div>
<a name="clearAll" id="clearAll"></a><div class="element clickable method public clearAll" data-toggle="collapse" data-target=".clearAll .collapse">
<h2>Clear all action arrays</h2>
<pre>clearAll() </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr></table>
</div></div>
</div>
<a name="run" id="run"></a><div class="element clickable method public run" data-toggle="collapse" data-target=".run .collapse">
<h2>Creates the main action (or clears current main action if there is one),
then executes the new main action.</h2>
<pre>run(mixed $route) </pre>
<div class="labels"></div>
<div class="row collapse">
<div class="span4">
<p class="long_description"></p>
<table class="table table-bordered">
<tr>
<th>uses</th>
<td>\framework\engine\Registry</td>
</tr>
<tr>
<th>example</th>
<td>error/not_found</td>
</tr>
</table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$route</h4>
<code>mixed</code><p>The controller name and optiontionally a directory name</p></div>
</div>
<div class="span4">
<h3>Examples</h3>
<pre class="prettyprint linenums"></pre>
</div>
</div>
</div>
<a name="breadcrumbs" id="breadcrumbs"></a><div class="element clickable method protected breadcrumbs" data-toggle="collapse" data-target=".breadcrumbs .collapse">
<h2>Creates and manages a list of breadcrumbs</h2>
<pre>breadcrumbs() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Uses session to store data if session is available, otherwise store
the breadcrumbs in a cookie.</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::breadcrumbs()</td>
</tr></table>
</div></div>
</div>
<a name="buildDirectories" id="buildDirectories"></a><div class="element clickable method private buildDirectories" data-toggle="collapse" data-target=".buildDirectories .collapse">
<h2>Decomposes provded route and sets file paths for controller, model and template
while a fully qualified namespaced class name, the method to call inside that
class and any parameters to pass to the method.</h2>
<pre>buildDirectories(string $route) </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Sets:
config->context,
$this->controller,
$this->method,
$this->methodArgs,
$this->class,
$this->model,
$this->template</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::buildDirectories()</td>
</tr></table>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$route</h4>
<code>string</code><p>a route in the form [context/]controller[/method/arg/arg/...]. The controller may stipulate a relative path</p>
</div>
</div></div>
</div>
<a name="clearRoutes" id="clearRoutes"></a><div class="element clickable method private clearRoutes" data-toggle="collapse" data-target=".clearRoutes .collapse">
<h2>Clears out the usefull data from the class.</h2>
<pre>clearRoutes() </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>Clears:
Controller file path
Model file path
Template file path
Class namespace name
Method name
Template name</p></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::clearRoutes()</td>
</tr></table>
</div></div>
</div>
<a name="execute" id="execute"></a><div class="element clickable method private execute" data-toggle="collapse" data-target=".execute .collapse">
<h2>Executes the action by instantiating requested controller and method.</h2>
<pre>execute(mixed $action) </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"><p>A great deal of setup is required prior to exectuing an action. Existance of
the controller on the file system has already been validated.  If the method
does not exist, the method will force a 404.</p></p>
<h3>Parameters</h3>
<div class="subelement argument">
<h4>$action</h4>
<code>mixed</code><p>Array of action paths</p></div>
</div></div>
</div>
<h3>
<i class="icon-custom icon-property"></i> Properties</h3>
<a name="%24class" id="$class"> </a><div class="element clickable property protected $class" data-toggle="collapse" data-target=".$class .collapse">
<h2>holds fully qualified namespaced class name</h2>
<pre>$class </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::$$class</td>
</tr></table>
</div></div>
</div>
<a name="%24context" id="$context"> </a><div class="element clickable property protected $context" data-toggle="collapse" data-target=".$context .collapse">
<h2>holds the app name as context</h2>
<pre>$context </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24controller" id="$controller"> </a><div class="element clickable property protected $controller" data-toggle="collapse" data-target=".$controller .collapse">
<h2>holds fully qualified file path to the controller name being processed</h2>
<pre>$controller </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::$$controller</td>
</tr></table>
</div></div>
</div>
<a name="%24front" id="$front"> </a><div class="element clickable property protected $front" data-toggle="collapse" data-target=".$front .collapse">
<h2>$front</h2>
<pre>$front </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24layout" id="$layout"> </a><div class="element clickable property protected $layout" data-toggle="collapse" data-target=".$layout .collapse">
<h2>$layout</h2>
<pre>$layout </pre>
<div class="labels"></div>
<div class="row collapse"><div class="detail-description"><p class="long_description"></p></div></div>
</div>
<a name="%24layout_name" id="$layout_name"> </a><div class="element clickable property protected $layout_name" data-toggle="collapse" data-target=".$layout_name .collapse">
<h2>holds the name of the view layout - this is the directory name for the view templates</h2>
<pre>$layout_name </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::$$layout_name</td>
</tr></table>
</div></div>
</div>
<a name="%24method" id="$method"> </a><div class="element clickable property protected $method" data-toggle="collapse" data-target=".$method .collapse">
<h2>hold requested method if a method was requested</h2>
<pre>$method </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::$$method</td>
</tr></table>
</div></div>
</div>
<a name="%24methodArgs" id="$methodArgs"> </a><div class="element clickable property protected $methodArgs" data-toggle="collapse" data-target=".$methodArgs .collapse">
<h2>holds an array of method arguments pass along with route to method</h2>
<pre>$methodArgs </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::$$methodArgs</td>
</tr></table>
</div></div>
</div>
<a name="%24model" id="$model"> </a><div class="element clickable property protected $model" data-toggle="collapse" data-target=".$model .collapse">
<h2>holds the fully qualified file path to the model</h2>
<pre>$model </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::$$model</td>
</tr></table>
</div></div>
</div>
<a name="%24template" id="$template"> </a><div class="element clickable property protected $template" data-toggle="collapse" data-target=".$template .collapse">
<h2>holds  fully qualified file path to the associated template</h2>
<pre>$template </pre>
<div class="labels"><span class="label">Inherited</span></div>
<div class="row collapse"><div class="detail-description">
<p class="long_description"></p>
<table class="table table-bordered"><tr>
<th>inherited_from</th>
<td>\framework\engine\Router::$$template</td>
</tr></table>
</div></div>
</div>
</div>
</div>
</div>
</div>
<div class="row"><footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by <a href="http://glyphicons.com/">Glyphicons</a>.<br>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor 2.0.0a7</a> and<br>
            generated on 2012-07-06T18:53:43-05:00.<br></footer></div>
</div>
</body>
</html>
